home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sstevx.z / sstevx
Encoding:
Text File  |  2002-10-03  |  7.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric tridiagonal matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSTEVX( JOBZ, RANGE, N, D, E, VL, VU, IL, IU, ABSTOL, M, W, Z,
  14.                         LDZ, WORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          REAL           D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      SSTEVX computes selected eigenvalues and, optionally, eigenvectors of a
  41.      real symmetric tridiagonal matrix A. Eigenvalues and eigenvectors can be
  42.      selected by specifying either a range of values or a range of indices for
  43.      the desired eigenvalues.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      JOBZ    (input) CHARACTER*1
  48.              = 'N':  Compute eigenvalues only;
  49.              = 'V':  Compute eigenvalues and eigenvectors.
  50.  
  51.      RANGE   (input) CHARACTER*1
  52.              = 'A': all eigenvalues will be found.
  53.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  54.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  55.  
  56.      N       (input) INTEGER
  57.              The order of the matrix.  N >= 0.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      D       (input/output) REAL array, dimension (N)
  75.              On entry, the n diagonal elements of the tridiagonal matrix A.
  76.              On exit, D may be multiplied by a constant factor chosen to avoid
  77.              over/underflow in computing the eigenvalues.
  78.  
  79.      E       (input/output) REAL array, dimension (N)
  80.              On entry, the (n-1) subdiagonal elements of the tridiagonal
  81.              matrix A in elements 1 to N-1 of E; E(N) need not be set.  On
  82.              exit, E may be multiplied by a constant factor chosen to avoid
  83.              over/underflow in computing the eigenvalues.
  84.  
  85.      VL      (input) REAL
  86.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  87.              the interval to be searched for eigenvalues. VL < VU.  Not
  88.              referenced if RANGE = 'A' or 'I'.
  89.  
  90.      IL      (input) INTEGER
  91.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  92.              order) of the smallest and largest eigenvalues to be returned.  1
  93.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  94.              referenced if RANGE = 'A' or 'V'.
  95.  
  96.      ABSTOL  (input) REAL
  97.              The absolute error tolerance for the eigenvalues.  An approximate
  98.              eigenvalue is accepted as converged when it is determined to lie
  99.              in an interval [a,b] of width less than or equal to
  100.  
  101.              ABSTOL + EPS *   max( |a|,|b| ) ,
  102.  
  103.              where EPS is the machine precision.  If ABSTOL is less than or
  104.              equal to zero, then  EPS*|T|  will be used in its place, where
  105.              |T| is the 1-norm of the tridiagonal matrix.
  106.  
  107.              Eigenvalues will be computed most accurately when ABSTOL is set
  108.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  109.              this routine returns with INFO>0, indicating that some
  110.              eigenvectors did not converge, try setting ABSTOL to
  111.              2*SLAMCH('S').
  112.  
  113.              See "Computing Small Singular Values of Bidiagonal Matrices with
  114.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  115.              Working Note #3.
  116.  
  117.      M       (output) INTEGER
  118.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  119.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  120.  
  121.      W       (output) REAL array, dimension (N)
  122.              The first M elements contain the selected eigenvalues in
  123.              ascending order.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      Z       (output) REAL array, dimension (LDZ, max(1,M) )
  141.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  142.              the orthonormal eigenvectors of the matrix A corresponding to the
  143.              selected eigenvalues, with the i-th column of Z holding the
  144.              eigenvector associated with W(i).  If an eigenvector fails to
  145.              converge (INFO > 0), then that column of Z contains the latest
  146.              approximation to the eigenvector, and the index of the
  147.              eigenvector is returned in IFAIL.  If JOBZ = 'N', then Z is not
  148.              referenced.  Note: the user must ensure that at least max(1,M)
  149.              columns are supplied in the array Z; if RANGE = 'V', the exact
  150.              value of M is not known in advance and an upper bound must be
  151.              used.
  152.  
  153.      LDZ     (input) INTEGER
  154.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  155.              'V', LDZ >= max(1,N).
  156.  
  157.      WORK    (workspace) REAL array, dimension (5*N)
  158.  
  159.      IWORK   (workspace) INTEGER array, dimension (5*N)
  160.  
  161.      IFAIL   (output) INTEGER array, dimension (N)
  162.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  163.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  164.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  165.              is not referenced.
  166.  
  167.      INFO    (output) INTEGER
  168.              = 0:  successful exit
  169.              < 0:  if INFO = -i, the i-th argument had an illegal value
  170.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  171.              indices are stored in array IFAIL.
  172.  
  173. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  174.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  175.  
  176.      This man page is available only online.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.